Early Preview

This is currently very much a preview. Please feel free to try things out, but don't be upset if anything is not yet working. Feedback is welcome over on our GitHub Dicussions page.

class Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions>

Assembly: Microsoft.AspNetCore.Authentication

Inheritance: object → AuthenticationHandler<TOptions> → RemoteAuthenticationHandler

Implemented Interfaces

IAuthenticationRequestHandler (Inherits: IAuthenticationHandler)

An opinionated abstraction for an <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1" /> that performs authentication using a separately hosted provider.

Properties

protected string

SignInScheme

The authentication scheme used by default for signin.

protected RemoteAuthenticationEvents

Events

The handler calls methods on the events which give the application control at certain points where processing is occurring. If it is not provided a default instance is supplied which does nothing when the methods are called.

public AuthenticationScheme

Scheme

public TOptions

Options

protected Http.HttpContext

Context

protected Http.HttpRequest

Request

protected Http.HttpResponse

Response

protected Http.PathString

OriginalPath

protected Http.PathString

OriginalPathBase

protected Extensions.Logging.ILogger

Logger

protected System.Text.Encodings.Web.UrlEncoder

UrlEncoder

protected ISystemClock

Clock

protected System.TimeProvider

TimeProvider

protected Extensions.Options.IOptionsMonitor<TOptions>

OptionsMonitor

protected object

Events

protected string

ClaimsIssuer

protected string

CurrentUri

Methods

protected System.Threading.Tasks.Task<object>

CreateEventsAsync()

public System.Threading.Tasks.Task<bool>

ShouldHandleRequestAsync()

Gets a value that determines if the current authentication request should be handled by <see cref="M:Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler`1.HandleRequestAsync" /> .

Returns <see langword="true" /> to handle the operation, otherwise <see langword="false" /> .

public System.Threading.Tasks.Task<bool>

HandleRequestAsync()

Handles the current authentication request.

Returns <see langword="true" /> if authentication was handled, otherwise <see langword="false" /> .

protected System.Threading.Tasks.Task<HandleRequestResult>

HandleRemoteAuthenticateAsync()

Authenticate the user identity with the identity provider. The method process the request on the endpoint defined by CallbackPath.

protected System.Threading.Tasks.Task<AuthenticateResult>

HandleAuthenticateAsync()

protected System.Threading.Tasks.Task

HandleForbiddenAsync(AuthenticationProperties properties)

protected void

GenerateCorrelationId(AuthenticationProperties properties)

Produces a cookie containing a nonce used to correlate the current remote authentication request.

protected bool

ValidateCorrelationId(AuthenticationProperties properties)

Validates that the current request correlates with the current remote authentication request.

protected System.Threading.Tasks.Task<HandleRequestResult>

HandleAccessDeniedErrorAsync(AuthenticationProperties properties)

Derived types may override this method to handle access denied errors.

Returns The <see cref="T:Microsoft.AspNetCore.Authentication.HandleRequestResult" /> .

properties The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties" /> .

public System.Threading.Tasks.Task

InitializeAsync(AuthenticationScheme scheme, Http.HttpContext context)